Skip to content

Docs: add ml-diagnostic guide #2800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Shuang-cnt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: add ml-diagnostic guide #2800

Shuang-cnt wants to merge 1 commit into from
+46 −1

Conversation

@Shuang-cnt
Copy link

@Shuang-cnt Shuang-cnt commented Dec 9, 2025 •
edited
Loading

Description

MaxText has integrated the ML Diagnostics SDK in the code. This PR aims to introduce ML Diagnostic flag managed_mldiagnostics=True
This flag will be used with 3 different scenarios:

  1. Only upload configs and metrics, not profiling (managed_mldiagnostics=True)
  2. Upload configs and metrics, and do profiling on the first device (managed_mldiagnostics=True and profiler=xplane)
  3. Upload configs and metrics, and do profiling on the all devices (managed_mldiagnostics=True, profiler=xplane, and upload_all_profiler_results=True)

Tests

I manually verified the updated instructions to ensure accuracy.

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed, including adding new documentation pages to the relevant Table of Contents (toctree directive) as explained in our documentation.

@Shuang-cnt Shuang-cnt marked this pull request as ready for review December 10, 2025 01:42
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch 4 times, most recently from cf662a5 to 29f463b Compare December 10, 2025 15:11
xibinliu
xibinliu reviewed Dec 10, 2025
View reviewed changes
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch 2 times, most recently from 0f722e5 to f2889b9 Compare December 10, 2025 20:05
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch from f2889b9 to 0edac7e Compare December 11, 2025 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xibinliu xibinliu xibinliu left review comments

@jacoguzo jacoguzo Awaiting requested review from jacoguzo jacoguzo is a code owner

@bvandermoon bvandermoon Awaiting requested review from bvandermoon bvandermoon is a code owner

@richjames0 richjames0 Awaiting requested review from richjames0 richjames0 is a code owner

@shralex shralex Awaiting requested review from shralex shralex is a code owner

@gobbleturk gobbleturk Awaiting requested review from gobbleturk gobbleturk is a code owner

@RissyRan RissyRan Awaiting requested review from RissyRan RissyRan is a code owner

@gagika gagika Awaiting requested review from gagika gagika is a code owner

@A9isha A9isha Awaiting requested review from A9isha A9isha is a code owner

@jiangjy1982 jiangjy1982 Awaiting requested review from jiangjy1982 jiangjy1982 is a code owner

@vipannalla vipannalla Awaiting requested review from vipannalla vipannalla is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Shuang-cnt @xibinliu